Skip to content

PWB: Set launcher.useTemplates: true by default#653

Merged
tnederlof merged 11 commits intomainfrom
tn-pwb-usetemplates-default
Mar 31, 2025
Merged

PWB: Set launcher.useTemplates: true by default#653
tnederlof merged 11 commits intomainfrom
tn-pwb-usetemplates-default

Conversation

@tnederlof
Copy link
Contributor

@tnederlof tnederlof commented Mar 31, 2025

This PR sets the default to launcher.useTemplates: true in the Workbench chart. This bumps the chart a minor version to 0.9.0 since it could be breaking if someone is using job-json-overrides because both cannot be set simultaneously. There is a check in the helm chart that will error if both job-json-overrides and launcher.useTemplates=true are defined, this PR adds to that error to note the chart version where this default was changed.

This being false by default is the most common root cause of customer issues we see in the field because without it many other chart defaults and examples Posit puts out will subtly not be applied (for example, session changes to pip.conf, imagePullSecrets, mounting storage to sessions etc.).

Historically before launcher.templateValues existed setting job-json-overrides was the way to customize jobs and it is still what is documented in our helm chart README. This PR removes the job-json-overrides language from the README and instead instructs users to use launcher.templateValues to customize the job templates.

Also worth noting that the Connect chart sets this default to true.

Copy link
Contributor

@GCRev GCRev left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM and we hope people read the changelog

@tnederlof
Copy link
Contributor Author

Hopefully there is enough detail
In the error message for people to have the action steps to resolve!

@tnederlof tnederlof merged commit a03e98a into main Mar 31, 2025
7 checks passed
@tnederlof tnederlof deleted the tn-pwb-usetemplates-default branch March 31, 2025 23:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants